______________________________________________________________________________

ReadMe.txt
______________________________________________________________________________

Copyright (C) 2007 Oxford Semiconductor Inc.

Author: David D. Chen

____________________________
Installation
____________________________

1. Install Windows CE 5.00 Platform Builder (PB) to development PC. Note the 
   WINCEROOT, i.e. the path where the CE 5.0 is installed (generally C:\WINCE500).

2. Double click the batch file "CopyDriverToWinCERoot.bat" to execute it. 
   This batch file will prompt the user to enter the WINCEROOT. The batch file 
   will then copy all files and sub-folders of the driver to the WINCEROOT.
   The following directory structure shall be seen:
   
	C:\WINCE500\OXSEMI
	               |------uarts
	               |        |
	               |        |-----....
	               |        |-----buspcie950
	               |        |-----compcie950
	               |        |-----isrpcie950
	               |        |-----....
		       |
                       |
	               |------APPS
	               |        |
	               |        |-----SUART
	               |        |-----....
	               |
                       |------....

3. Start Platform Builder and create a new platform.

4. Click File->Manage Catalog Features to start Manage Catalog Features dialog

5. Click Import button to start Import Catalog Features dialog and import 
   cec files of pcie950.cec in the subdirectory of \uarts\buspcie950\"

6. Add "pcie950" feature to the platform by right-click on its logo and choose
   Add to Platform

7. Build (or Rebuild) OS using menu command of "Build OS->BUild and Sysgen"
   Add to Platform if the OS has not been built yet, or build the PCIe950
   driver by command of "Build Project->Built All Projects" (with "Clean before
   Build" unchecked) 

8. The 1st 9 installed (PCIe950) devices are given conventional names of COM1:
   to COM9: and all subsequently installed PCIe950 devices will be named as 
   CMx1: to CMx9: accordingly, where x is a digit of 1 to 9.

9. Each port can be configured using the built-in application "SUART", which can
   be started by the command of "Start->Run...->suart".
   
______________________________________________________________________________

Modifications required
______________________________________________________________________________

Crystal Frequency
_________________

As PCIE950 family devices have fixed input clock frequency (62.5MHz), the default
Crystal Frequency has been defined in the "buspcie950.Reg" file and should not be
changed in any circumstances.


Interrupt triggering and flow control levels
____________________________________________

Four level control values can be defined in "pci16950.reg" file (brackets indicate
the correcponding 16950 registers, to where the values will be stored when device
driver being loaded):

    "RxIntTrigLevel" ------ Receive Interrupt Triggering Level (RTL)
    "TxIntTrigLevel" ------ Transmit Interrupt Triggering Level (TTL)
    "FlowCtrlLowLevel" ---- Automatic Flow Control Lower Trigger Level (FCL)
    "FlowCtrlHighLevel" --- Automatic Flow Control Higher Trigger Level (FCH)

The level control values defined in "buspcie950.reg" file shall be used as default
values by all UART channels.

The level value are expressed in hexadecimal, NOT DECIMAL. For example, to set
the Receive Interrupt Triggering Level to 95, the following line should exist
under the corresponging key:

    "RxIntTrigLevel"=dword:5F

If required, the level control values of each UART channel can be changed
individually using "SUART".

Interrupt triggering and flow control levels
____________________________________________

Baudrate Map List can be defined in "pcie950.reg" file using the two registry
values:

    "BaudrateMapListFrom" --- Baudrate Map List for From baudrates
    "BaudrateMapListTo" ----- Baudrate Map List for To baudrates

The baudrate map list defined in pcie950.reg file shall be used as default by
all UART channels.

The baudrate values are expressed in decimal. For example, to map baudrates of
230,400 and 1,843,200 to the baudrates of 1,200 and 2,400, the following lines
should exist under the corresponding key:

    "BaudrateMapListFrom"=multi_sz:"1200","2400"
    "BaudrateMapListTo"=multi_sz:"230400","1843200"

If required, the baudrate map list of each UART channel can be modified
individually using "SUART".


________________________________________________________________________________

                                 End of ReadMe
________________________________________________________________________________
